Skip to main content

Exchange overview

Authentication

Two types of authentication are available:

  • As a recruiter
  • As an application

As recruiter​

API endpoint /token using the POST verb with the authentication type as a parameter (grant_type) = "urn:ietf:params:oauth:grant-type:jwt-bearer" and an assertion (assertion) containing a JWT token with the recruiters e-mail and a client identifier.

As application​

API endpoint /token using the POST verb with the authentication type as a parameter (grant_type) = "client_credentials", a client identifier (client_id) and a secret key (client_secret).

Campaign choice

API endpoint /campaign using the GET verb that returns the list of active campaigns in order to chose the one that will be used to invite the candidate. The return is composed of a campaign identifier (campaign_id), of its name (name) and its language (language). It is possible to a a keyword (keyword) and language (language) parameter to filter the list.

Direct access link to campaign creation

API Endpoint /campaigncreationlink to get a direct link to campaign creation. This feature is not required.

Invitation

API Endpoint /interview using the POST verb to send an invitation by e-mail to the candidate(s).

Takes as a parameter a list of candidates with the following parameters:

  • Campaign identifier (campaign_id)
  • Applicant identifier: UUID issued by Talentsoft (applicant_id)
  • Last Name (lastname)
  • First Name (firstname)
  • Application identifier: UUID issued by Talentsoft (application_id)
  • E-mail (email)
  • Optional: Phone number (phone)
  • Optional: Callback URL to update the interview status in Talentsoft

The return is composed of the following attributes:

  • Applicant identifier (applicant_id)
  • Application identifier (application_id)
  • Invitation link to the video interview (interview_invitation_link)
  • Status of the request (status success/error)
  • Error message (error_message)

Get the interview status

API Endpoint /interview using the GET verb to get the interview status.

Takes as a parameter a list of application identifiers (applications) or a campaign identifier (campaign_id).

Returns a list of interviews with the following attributes:

  • Applicant identifier (applicant_id)
  • Application identifier (applicant_id)
  • Last Name (lastname)
  • First Name (firstname)
  • E-mail (email)
  • Optional: Phone number (phone)
  • Status
    • Waiting (Waiting for applicant answer)
    • Completed (Completer by applicant)
    • Expired
    • ApplicantDeclined (Declined by the applicant)
    • Cancelled (Cancelled by the recruiter)
    • Deleted
    • Archived
  • Optional: Applicant invitation link (interview_invitation_link)
  • Recruiter link to the results (recruiter_link)
  • Optional: Link to the results that can be integrated in iFrame (readonly_link_link)
  • Optional: Shortlisted (shortlisted true/false)
  • Optional: Average evaluation mark on a 0 to 5 scale (evaluation_score)
  • Optional: Evaluation mark in percentage (score)

Applicant deletion request

API Endpoint /interview using the DELETE verb to delete the applicants data.

Takes as parameters a list of campaign identifiers (campaign_id) and an e-mail (email).

Applicant personnal data must be deleted in conformity to GDPR.

Callback

This API Endpoint is exposed by Talentsoft. See API documentation for definition and testing.

This callback is used to launch the call from Talentsoft to the previouly defined /interview API Endpoint.